// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2025-02-25

package providers

import "gitee.com/go-libs/console"

// Option
// 命令行选项.
//
//	{
//	    "short": 'h',
//	    "description": "Hostname of the consul server",
//	    "default_value": "localhost:8500",
//	    "kind": 0,
//	    "required": false,
//	}
type Option struct {
	// Short
	// 选项短名.
	Short byte

	// Description
	// 关于选项的简略描述.
	Description string

	// DefaultValue
	// 选项默认值, 若在命令行中未指定指则使用该默认值.
	DefaultValue string

	// Kind
	// 选项类型.
	Kind console.Kind

	// Required
	// 是否必须.
	Required bool
}
